rrweb docs
rrwebDocs

English

简体中文

English

简体中文

Get recording player​

GET
/recordings/{recordingId}/player

Serves the recording player HTML page. Request /recordings/{recordingId}/player.html or send Accept: text/html for the HTML representation. File extensions take precedence over the Accept header when both are present.

Authorizations

Private API Key
Private API Key
Bearer token for authentication. Use your private API key as the token.
or
Presigned URL
Presigned URL
Use a presigned URL generated by the List Recordings endpoint with includeSignedUrls=true. Time-constrained and scoped to a single recording, so it can be exposed publicly in your replayer.
Show parameters: TenantId, KeyId, Expires, Signature
TenantId
Your organization ID. Included automatically in generated presigned URLs; keep the returned value unchanged.
KeyId
Identifies the key used to verify the presigned URL. Included automatically in generated URLs; keep the returned value unchanged.
Expires
Expiration timestamp (UNIX seconds)
Signature
Authenticates the presigned URL. Use the URL returned by the API without changing its path or authentication parameters.

Parameters​

Path Parameters

recordingId*

The recording ID

Type
string
Required
Example"000e8400-e00b-00d0-a716-446655440000"
Format
"uuid"

Query Parameters

playerVersion

Optional exact version of rrweb-player. JavaScript and CSS use the same version. Defaults to the configured CDN channel, resolved to an exact version. Unsupported versions return 400. Player pages also reject unpublished versions with 400 and return 503 if availability cannot be checked.

Type
string
Example"2.1.1"
embed

Player layout: omitted or false shows the standard page; true aliases controls. Embed presets fill the container without surrounding page UI: controls keeps controls visible, controls-hover reveals them on hover or keyboard focus (always visible on touch devices), and controls-hidden removes them completely. All presets support paused, autoplay, and looping playback.

Type
string
Valid values
"false""true""controls""controls-hover""controls-hidden"
Example"controls-hidden"
autoplay

Playback on load: false pauses (default), true plays once, and loop plays repeatedly. The initial pass starts at time; subsequent passes restart from the beginning. Looping from the recording end starts at the beginning.

Type
string
Valid values
"false""true""loop"
Example"false"
speed

Playback speed from 0.25 to 4 (default: 1). Values outside this range return 400.

Type
string
Example"1"
time

Playback position selector. Supports offset, percent, and epoch formats: offset:5000, offset:-5000, percent:50, or epoch:1702900000000. Defaults to offset:0.

Type
string
Example"offset:0"
eventsUrl

Optional URL from which the player loads recording events. Use a relative URL or a URL on the same origin as the player, such as a presigned events URL.

Type
string
Example"https://api.example.com/recordings/000e8400-e00b-00d0-a716-446655440000/events?tenantId=tenant-123&expires=1700000000&keyId=key-2025-12&signature=abcdef"

Responses​

Recording player HTML page

text/html
JSON
"<!doctype html>"

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI